WriteTags(string,int,IEnumerable<RasterTagMetadata>) Method

Summary

Writes or changes one or more tags to an existing file.

Syntax

Objective-C

C++

public void WriteTags( 
   string fileName, 
   int pageNumber, 
   IEnumerable<RasterTagMetadata> tags 
)

Public Overloads Sub WriteTags( _ 
   ByVal fileName As String, _ 
   ByVal pageNumber As Integer, _ 
   ByVal tags As IEnumerable(Of RasterTagMetadata) _ 
)

- (BOOL)writeTags:(nullable NSArray<LTRasterTagMetadata *> *)tags  
           toFile:(NSString *)file  
       pageNumber:(NSInteger)pageNumber  
            error:(NSError **)error

public: 
void WriteTags(  
   String^ fileName, 
   int pageNumber, 
   IEnumerable<RasterTagMetadata^>^ tags 
)

Parameters

fileName
A String that contains the file name.

pageNumber
1-based index of the page at which to write the tag.

tags
A collection of RasterTagMetadata objects to identify the data in the TIFF file.

Remarks

This method writes tags into an existing file or changes tags in an existing file.

This method works only with TIFF files.

Note: Use this method carefully. LEADTOOLS will not restrict the tags that you write. If you write bad tags, the file might become corrupted. Consult the TIFF documentation for a list of predefined tags. It is recommended that you write only the user-defined tags (the tags between 0x8000 and 0xFFFF).

See the TIFF documentation for a complete list of the TIFF tags and types.

Some restrictions apply to this function if you use an IFD to indicate to which page to write the comment. See the Loading and Saving Large TIFF / BigTIFF Files topic for more information.

Example

For an example, refer to EnumTags.

Requirements

Target Platforms